vcVolumeSensor

vcVolumeSensor detects when components' bounding boxes intersect with a defined box-like volume in the 3D world. The detection volume is a axis-aligned box in world coordinates, which is defined by two Frames. The sensor can optionally only detect components within the DetectionContainer.

See in: Overview

Module: vcBehaviors

Parent: vcBehavior

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
BoolSignal	vcBooleanSignal	RW	Gets or sets the Boolean Signal which is set to True when the volume sensor has a valid component intersecting the volume.
ComponentSignal	vcComponentSignal	RW	Gets or sets the Component Signal which sends out the intersecting component.
DetectionContainer	vcContainer	RW	Gets or sets the component container which is used to filter the components that should trigger the sensor.
LowerFrame	vcFrameFeature	RW	Gets or sets the vcFeatureFrame which determines the first corner of the volume.
SampleTime	Real	RW	Gets or sets the sampling rate, in seconds.
ShowVolume	Boolean	RW	Gets or sets if the detection area should be visualized.
TestMethod	vcVolumeSensorTestMethod	RW	Gets or sets the test method for detecting collisions. See vcVolumeSensorTestMethod constants for more information.
TestOnlyContained	Boolean	RW	Gets or sets if the sensor should only detect components in the DetectionContainer.
TestParent	Boolean	RW	Gets or sets a boolean that determines if the sensor should detect the parent component.
TestSiblings	Boolean	RW	Gets or sets if the sensor should detect components that have this behaviors' component as a parent.
UpdateScene	Boolean	RW	Gets or sets if the detected components should schedule a simulation update when detected.
UpperFrame	vcFrameFeature	RW	Gets or sets the vcFeatureFrame which determines the second corner of the volume.
UseSampling	Boolean	RW	Gets or sets if the sensor should update based on the sampling rate or only manually.
VolumeMaterial	vcMaterial	RW	Gets or sets a vcMaterial which is used to visualize the detection area.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
processVolume	None	None	Manually trigger the volume sensor to check if any valid components are intersecting the volume.